/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2017-2023 Ta4j Organization & respective
 * authors (see AUTHORS)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.ta4j.core.reports;

import org.ta4j.core.num.Num;

/**
 * Represents a report that contains performance statistics.
 */
public class PerformanceReport {

    /** The total PnL. */
    private final Num totalProfitLoss;

    /** The total PnL in percent. */
    private final Num totalProfitLossPercentage;

    /** The total profit. */
    private final Num totalProfit;

    /** The total loss. */
    private final Num totalLoss;

    /**
     * Constructor.
     * 
     * @param totalProfitLoss           the total PnL
     * @param totalProfitLossPercentage the total PnL in percent
     * @param totalProfit               the total profit
     * @param totalLoss                 the total loss
     */
    public PerformanceReport(Num totalProfitLoss, Num totalProfitLossPercentage, Num totalProfit, Num totalLoss) {
        this.totalProfitLoss = totalProfitLoss;
        this.totalProfitLossPercentage = totalProfitLossPercentage;
        this.totalProfit = totalProfit;
        this.totalLoss = totalLoss;
    }

    /** @return {@link #totalProfitLoss} */
    public Num getTotalProfitLoss() {
        return totalProfitLoss;
    }

    /** @return {@link #totalProfitLossPercentage} */
    public Num getTotalProfitLossPercentage() {
        return totalProfitLossPercentage;
    }

    /** @return {@link #totalProfit} */
    public Num getTotalProfit() {
        return totalProfit;
    }

    /** @return {@link #totalLoss} */
    public Num getTotalLoss() {
        return totalLoss;
    }
}
